<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.interconnects.html">interconnects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#delete">delete(project, interconnect, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified Interconnect.</p>
<p class="toc_element">
  <code><a href="#get">get(project, interconnect, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the specified Interconnect. Get a list of available Interconnects</p>
<p class="toc_element">
  <code><a href="#getDiagnostics">getDiagnostics(project, interconnect, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the interconnectDiagnostics for the specified</p>
<p class="toc_element">
  <code><a href="#getMacsecConfig">getMacsecConfig(project, interconnect, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the interconnectMacsecConfig for the specified</p>
<p class="toc_element">
  <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an Interconnect in the specified project using</p>
<p class="toc_element">
  <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the list of Interconnects available to the specified project.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(project, interconnect, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified Interconnect with the data included in the request.</p>
<p class="toc_element">
  <code><a href="#setLabels">setLabels(project, resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the labels on an Interconnect. To learn more about labels,</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(project, interconnect, requestId=None, x__xgafv=None)</code>
  <pre>Deletes the specified Interconnect.

Args:
  project: string, Project ID for this request. (required)
  interconnect: string, Name of the interconnect to delete. (required)
  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.

For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.

The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(project, interconnect, x__xgafv=None)</code>
  <pre>Returns the specified Interconnect. Get a list of available Interconnects
by making a list() request.

Args:
  project: string, Project ID for this request. (required)
  interconnect: string, Name of the interconnect to return. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Interconnect resource.
    #
    # An Interconnect resource is a dedicated connection between the Google
    # Cloud network and your on-premises network. For more information, read the
    # Dedicated Interconnect Overview.
  &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
      # Interconnect.
  &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
      # Interconnect is functional and can carry traffic.
      # When set to false, no packets can be carried over the interconnect and
      # no BGP routes are exchanged over it. By default, the status is set to true.
  &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
      # Interconnect.
      # Interconnect.
    &quot;bandwidthPercentagePolicy&quot;: {
      &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
          # type Bandwidth Percent.
        { # Specify bandwidth percentages [1-100] for various traffic classes in
            # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
            # All traffic classes must have a percentage value specified.
          &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
          &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
        },
      ],
    },
    &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
        # Interconnect.
    &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
        # applied in conjunction with StrictPriorityPolicy or
        # BandwidthPercentagePolicy.
      { # Specify bandwidth percentages [1-100] for various traffic classes in
          # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
          # All traffic classes must have a percentage value specified.
        &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
        &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
      },
    ],
    &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
    },
  },
  &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
      # which can take one of the following values:
      #
      #    - IF_MACSEC: If present, then the Interconnect connection is
      #    provisioned on MACsec capable hardware ports. If not present, then the
      #    Interconnect connection is provisioned on non-MACsec capable ports. Any
      #    attempt to enable MACsec will fail.
      #    - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
      #    provisioned exclusively for Cross-Site Networking. Any attempt to configure
      #    VLAN attachments will fail. If not present, then the Interconnect
      #    connection is not provisioned for Cross-Site Networking. Any attempt to use
      #    it for Cross-Site Networking will fail.
    &quot;A String&quot;,
  ],
  &quot;circuitInfos&quot;: [ # [Output Only] A list of CircuitInfo objects, that describe the individual
      # circuits in this LAG.
    { # Describes a single physical circuit between the Customer and Google.
        # CircuitInfo objects are created by Google, so all fields are output only.
      &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
      &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
      &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
          # provided by Google to the customer in the LOA.
    },
  ],
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
      # text format.
  &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
      # authorized to request a crossconnect.
  &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
      # create the resource.
  &quot;expectedOutages&quot;: [ # [Output Only] A list of outages expected for this Interconnect.
    { # Description of a planned outage on this Interconnect.
      &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
          # IDs that will be affected.
        &quot;A String&quot;,
      ],
      &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
      &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
          # epoch).
      &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
          # values:
          #
          #    - OUTAGE: The Interconnect may be completely out of service for
          #    some or all of the specified window.
          #    - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
          #    should remain up, but with reduced bandwidth.
          #
          #
          # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
          # deprecated in favor of the unprefixed values.
      &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
      &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
          # value:
          #
          #    - GOOGLE: this notification as generated by Google.
          #
          #
          # Note that the value of NSRC_GOOGLE has been deprecated in favor of
          # GOOGLE.
      &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
          # epoch).
      &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
          #
          #    - ACTIVE: This outage notification is active. The event could be in
          #    the past, present, or future. See start_time and end_time for
          #    scheduling.
          #    - CANCELLED: The outage associated with this notification was cancelled
          #    before the outage was due to start.
          #    - COMPLETED: The outage associated with this notification is complete.
          #
          #
          # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
          # deprecated in favor of the unprefixed values.
    },
  ],
  &quot;googleIpAddress&quot;: &quot;A String&quot;, # [Output Only] IP address configured on the Google side of the Interconnect
      # link. This can be used only for ping tests.
  &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID to be used when raising support tickets
      # with Google or otherwise to debug backend connectivity issues.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
      # defined by the server.
  &quot;interconnectAttachments&quot;: [ # [Output Only] A list of the URLs of all InterconnectAttachments configured
      # to use  this Interconnect.
    &quot;A String&quot;,
  ],
  &quot;interconnectGroups&quot;: [ # [Output Only] URLs of InterconnectGroups that include this Interconnect.
      # Order is arbitrary and items are unique.
    &quot;A String&quot;,
  ],
  &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
      #
      #    - PARTNER: A partner-managed interconnection shared between customers
      #    though a partner.
      #    - DEDICATED: A dedicated physical interconnection with the
      #    customer.
      #
      #
      # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
  &quot;kind&quot;: &quot;compute#interconnect&quot;, # [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
  &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
      # is essentially a hash of the labels set used for optimistic locking. The
      # fingerprint is initially generated by Compute Engine and changes after
      # every request to modify or update labels. You must always provide an
      # up-to-date fingerprint hash in order to update or change labels,
      # otherwise the request will fail with error412 conditionNotMet.
      #
      # To see the latest fingerprint, make a get() request to
      # retrieve an Interconnect.
  &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      # Label values may be empty.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
      #
      #    - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
      #    - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
      #    - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
      #
      #
      #  Note that this field indicates the speed of each of
      # the links in the bundle, not the speed of the entire bundle.
  &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
      # connection is to be provisioned.
  &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
      # Cloud Interconnect connection between Google and your on-premises router.
      # (MACsec) on this Cloud Interconnect connection between Google and your
      # on-premises router.
    &quot;failOpen&quot;: True or False, # If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google
        # router to fallback to cleartext traffic if the MKA session cannot be
        # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
        # MKA session cannot be established with your router.
    &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
        # along with their start times. A MACsec CKN/CAK is generated for each
        # key in the key chain. Google router automatically picks the key with
        # the most recent startTime when establishing or re-establishing a MACsec
        # secure link.
      { # Describes a pre-shared key used to setup MACsec in static connectivity
          # association key (CAK) mode.
        &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
            # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
            # characters long and match the regular expression
            # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
            # lowercase letter, and all following characters must be a dash,
            # lowercase letter, or digit, except the last character, which cannot be
            # a dash.
        &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
            # valid. startTime can be in the future. If the keychain has a single
            # key, startTime can be omitted. If the keychain has multiple keys,
            # startTime is mandatory for each key. The start times of keys must be in
            # increasing order. The start times of two consecutive keys must be
            # at least 6 hours apart.
      },
    ],
  },
  &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
      # fails if the MACsec object is not specified.
  &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
      # The name must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the name must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must be
      # a dash, lowercase letter, or digit, except the last character, which cannot
      # be a dash.
  &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
      # notifications regarding this Interconnect. If specified, this will be used
      # for notifications in addition to all other forms described, such as
      # Cloud Monitoring logs alerting and Cloud Notifications. This field is
      # required for users who sign up for Cloud Interconnect using
      # workforce identity federation.
  &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of this Interconnect&#x27;s functionality,
      # which can take one of the following values:
      #
      #    - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
      #    use. Attachments may be provisioned on this Interconnect.
      #
      # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
      # attachments may be provisioned on this Interconnect.
      # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
      # maintenance. No attachments may be provisioned or updated on this
      # Interconnect.
  &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
      # as part of resource payload.
    &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
        # Tag keys and values have the same definition as resource
        # manager tags. The field is allowed for INSERT
        # only. The keys/values to set on the resource should be specified in
        # either ID { : } or Namespaced format
        # { : }.
        # For example the following are valid inputs:
        # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
        # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
        # Note:
        # * Invalid combinations of ID &amp; namespaced format is not supported. For
        #   instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
        # * Inconsistent format is not supported. For instance:
        #   {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
  },
  &quot;peerIpAddress&quot;: &quot;A String&quot;, # [Output Only] IP address configured on the customer side of the
      # Interconnect link. The customer should configure this IP address during
      # turnup when prompted by Google NOC. This can be used only for ping tests.
  &quot;provisionedLinkCount&quot;: 42, # [Output Only] Number of links actually provisioned in this interconnect.
  &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
      # location outside of Google&#x27;s network that the interconnect is connected to.
  &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
      # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
      # Interconnect connection, which can take one of the following values:
      #
      #    - IF_MACSEC: If specified, then the connection is created on MACsec
      #    capable hardware ports. If not specified, non-MACsec capable ports will
      #    also be considered.
      #    - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
      #    exclusively for Cross-Site Networking. The connection can not be used for
      #    Cross-Site Networking unless this feature is specified.
    &quot;A String&quot;,
  ],
  &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
      # customer.
  &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of Interconnect functionality, which can
      # take one of the following values:
      #
      #    - ACTIVE: The Interconnect is valid, turned up and ready to use.
      #    Attachments may be provisioned on this Interconnect.
      #    - UNPROVISIONED: The Interconnect has not completed turnup. No
      #    attachments may be provisioned on this Interconnect.
      #    - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
      #    No attachments may be provisioned or updated on this
      #    Interconnect.
  &quot;subzone&quot;: &quot;A String&quot;, # Specific subzone in the InterconnectLocation that represents where
      # this connection is to be provisioned.
  &quot;wireGroups&quot;: [ # [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
      # configured to use this Interconnect. The Interconnect cannot be deleted if
      # this list is non-empty.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="getDiagnostics">getDiagnostics(project, interconnect, x__xgafv=None)</code>
  <pre>Returns the interconnectDiagnostics for the specified
Interconnect.

In the event of a
global outage, do not use this API to make decisions about where to
redirect your network traffic.

Unlike a VLAN attachment, which is regional, a Cloud Interconnect
connection is a global resource. A global outage can prevent this
API from functioning properly.

Args:
  project: string, Project ID for this request. (required)
  interconnect: string, Name of the interconnect resource to query. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the InterconnectsGetDiagnosticsRequest.
  &quot;result&quot;: { # Diagnostics information about the Interconnect connection, which contains
      # detailed and current technical information about Google&#x27;s side of the
      # connection.
    &quot;arpCaches&quot;: [ # A list of InterconnectDiagnostics.ARPEntry objects,
        # describing individual neighbors currently seen by the Google router in
        # the ARP cache for the Interconnect.
        # This will be empty when the Interconnect is not bundled.
      { # Describing the ARP neighbor entries seen on this link
        &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this ARP neighbor.
        &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of this ARP neighbor.
      },
    ],
    &quot;bundleAggregationType&quot;: &quot;A String&quot;, # The aggregation type of the bundle interface.
    &quot;bundleOperationalStatus&quot;: &quot;A String&quot;, # The operational status of the bundle interface.
    &quot;links&quot;: [ # A list of InterconnectDiagnostics.LinkStatus objects,
        # describing the status for each link on the Interconnect.
      {
        &quot;arpCaches&quot;: [ # A list of InterconnectDiagnostics.ARPEntry objects,
            # describing the ARP neighbor entries seen on this link.
            # This will be empty if the link is bundled
          { # Describing the ARP neighbor entries seen on this link
            &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this ARP neighbor.
            &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of this ARP neighbor.
          },
        ],
        &quot;circuitId&quot;: &quot;A String&quot;, # The unique ID for this link assigned during turn up by Google.
        &quot;googleDemarc&quot;: &quot;A String&quot;, # The Demarc address assigned by Google and provided in the LoA.
        &quot;lacpStatus&quot;: {
          &quot;googleSystemId&quot;: &quot;A String&quot;, # System ID of the port on Google&#x27;s side of the LACP exchange.
          &quot;neighborSystemId&quot;: &quot;A String&quot;, # System ID of the port on the neighbor&#x27;s side of the LACP exchange.
          &quot;state&quot;: &quot;A String&quot;, # The state of a LACP link, which can take one of the following values:
              #
              #    - ACTIVE: The link is configured and active within the bundle.
              #    - DETACHED: The link is not configured within the bundle. This means
              #    that the rest of the object should be empty.
        },
        &quot;macsec&quot;: { # Describes the status of MACsec encryption on the link. # Describes the status of MACsec encryption on this link.
          &quot;ckn&quot;: &quot;A String&quot;, # Indicates the Connectivity Association Key Name (CKN)
              # currently being used if MACsec is operational.
          &quot;operational&quot;: True or False, # Indicates whether or not MACsec is operational on this link.
        },
        &quot;operationalStatus&quot;: &quot;A String&quot;, # The operational status of the link.
        &quot;receivingOpticalPower&quot;: { # An InterconnectDiagnostics.LinkOpticalPower object,
            # describing the current value and status of the received light level.
          &quot;state&quot;: &quot;A String&quot;, # The status of the current value when compared to the warning and alarm
              # levels for the receiving or transmitting transceiver. Possible states
              # include:
              #
              #
              #     - OK: The value has not crossed a warning threshold.
              #     - LOW_WARNING: The value has crossed below the low
              #     warning threshold.
              #    - HIGH_WARNING: The value has
              #     crossed above the high warning threshold.
              #     - LOW_ALARM: The value has crossed below the low alarm
              #     threshold.
              #     - HIGH_ALARM: The value has crossed above the high alarm
              #     threshold.
          &quot;value&quot;: 3.14, # Value of the current receiving or transmitting optical power, read in
              # dBm. Take a known good optical value, give it a 10% margin and trigger
              # warnings relative to that value. In general, a -7dBm warning and a -11dBm
              # alarm are good optical value estimates for most links.
        },
        &quot;transmittingOpticalPower&quot;: { # An InterconnectDiagnostics.LinkOpticalPower object,
            # describing the current value and status of the transmitted light level.
          &quot;state&quot;: &quot;A String&quot;, # The status of the current value when compared to the warning and alarm
              # levels for the receiving or transmitting transceiver. Possible states
              # include:
              #
              #
              #     - OK: The value has not crossed a warning threshold.
              #     - LOW_WARNING: The value has crossed below the low
              #     warning threshold.
              #    - HIGH_WARNING: The value has
              #     crossed above the high warning threshold.
              #     - LOW_ALARM: The value has crossed below the low alarm
              #     threshold.
              #     - HIGH_ALARM: The value has crossed above the high alarm
              #     threshold.
          &quot;value&quot;: 3.14, # Value of the current receiving or transmitting optical power, read in
              # dBm. Take a known good optical value, give it a 10% margin and trigger
              # warnings relative to that value. In general, a -7dBm warning and a -11dBm
              # alarm are good optical value estimates for most links.
        },
      },
    ],
    &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of the Interconnect&#x27;s bundle interface.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="getMacsecConfig">getMacsecConfig(project, interconnect, x__xgafv=None)</code>
  <pre>Returns the interconnectMacsecConfig for the specified
Interconnect.

Args:
  project: string, Project ID for this request. (required)
  interconnect: string, Name of the interconnect resource to query. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the InterconnectsGetMacsecConfigRequest.
  &quot;etag&quot;: &quot;A String&quot;, # end_interface: MixerGetResponseWithEtagBuilder
  &quot;result&quot;: { # MACsec configuration information for the Interconnect connection. Contains
      # the generated Connectivity Association Key Name (CKN) and the key (CAK) for
      # this Interconnect connection.
    &quot;preSharedKeys&quot;: [ # A keychain placeholder describing a set of named key objects
        # along with their start times. A MACsec CKN/CAK is generated for each key in
        # the key chain. Google router automatically picks the key with the most
        # recent startTime when establishing or re-establishing a MACsec secure link.
      { # Describes a pre-shared key used to setup MACsec in static connectivity
          # association key (CAK) mode.
        &quot;cak&quot;: &quot;A String&quot;, # An auto-generated Connectivity Association Key (CAK) for this key.
        &quot;ckn&quot;: &quot;A String&quot;, # An auto-generated Connectivity Association Key Name (CKN) for this key.
        &quot;name&quot;: &quot;A String&quot;, # User provided name for this pre-shared key.
        &quot;startTime&quot;: &quot;A String&quot;, # User provided timestamp on or after which this key is valid.
      },
    ],
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
  <pre>Creates an Interconnect in the specified project using
the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an Interconnect resource.
    # 
    # An Interconnect resource is a dedicated connection between the Google
    # Cloud network and your on-premises network. For more information, read the
    # Dedicated Interconnect Overview.
  &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
      # Interconnect.
  &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
      # Interconnect is functional and can carry traffic.
      # When set to false, no packets can be carried over the interconnect and
      # no BGP routes are exchanged over it. By default, the status is set to true.
  &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
      # Interconnect.
      # Interconnect.
    &quot;bandwidthPercentagePolicy&quot;: {
      &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
          # type Bandwidth Percent.
        { # Specify bandwidth percentages [1-100] for various traffic classes in
            # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
            # All traffic classes must have a percentage value specified.
          &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
          &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
        },
      ],
    },
    &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
        # Interconnect.
    &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
        # applied in conjunction with StrictPriorityPolicy or
        # BandwidthPercentagePolicy.
      { # Specify bandwidth percentages [1-100] for various traffic classes in
          # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
          # All traffic classes must have a percentage value specified.
        &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
        &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
      },
    ],
    &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
    },
  },
  &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
      # which can take one of the following values:
      # 
      #    - IF_MACSEC: If present, then the Interconnect connection is
      #    provisioned on MACsec capable hardware ports. If not present, then the
      #    Interconnect connection is provisioned on non-MACsec capable ports. Any
      #    attempt to enable MACsec will fail.
      #    - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
      #    provisioned exclusively for Cross-Site Networking. Any attempt to configure
      #    VLAN attachments will fail. If not present, then the Interconnect
      #    connection is not provisioned for Cross-Site Networking. Any attempt to use
      #    it for Cross-Site Networking will fail.
    &quot;A String&quot;,
  ],
  &quot;circuitInfos&quot;: [ # [Output Only] A list of CircuitInfo objects, that describe the individual
      # circuits in this LAG.
    { # Describes a single physical circuit between the Customer and Google.
        # CircuitInfo objects are created by Google, so all fields are output only.
      &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
      &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
      &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
          # provided by Google to the customer in the LOA.
    },
  ],
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
      # text format.
  &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
      # authorized to request a crossconnect.
  &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
      # create the resource.
  &quot;expectedOutages&quot;: [ # [Output Only] A list of outages expected for this Interconnect.
    { # Description of a planned outage on this Interconnect.
      &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
          # IDs that will be affected.
        &quot;A String&quot;,
      ],
      &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
      &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
          # epoch).
      &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
          # values:
          #
          #    - OUTAGE: The Interconnect may be completely out of service for
          #    some or all of the specified window.
          #    - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
          #    should remain up, but with reduced bandwidth.
          #
          #
          # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
          # deprecated in favor of the unprefixed values.
      &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
      &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
          # value:
          #
          #    - GOOGLE: this notification as generated by Google.
          #
          #
          # Note that the value of NSRC_GOOGLE has been deprecated in favor of
          # GOOGLE.
      &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
          # epoch).
      &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
          #
          #    - ACTIVE: This outage notification is active. The event could be in
          #    the past, present, or future. See start_time and end_time for
          #    scheduling.
          #    - CANCELLED: The outage associated with this notification was cancelled
          #    before the outage was due to start.
          #    - COMPLETED: The outage associated with this notification is complete.
          #
          #
          # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
          # deprecated in favor of the unprefixed values.
    },
  ],
  &quot;googleIpAddress&quot;: &quot;A String&quot;, # [Output Only] IP address configured on the Google side of the Interconnect
      # link. This can be used only for ping tests.
  &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID to be used when raising support tickets
      # with Google or otherwise to debug backend connectivity issues.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
      # defined by the server.
  &quot;interconnectAttachments&quot;: [ # [Output Only] A list of the URLs of all InterconnectAttachments configured
      # to use  this Interconnect.
    &quot;A String&quot;,
  ],
  &quot;interconnectGroups&quot;: [ # [Output Only] URLs of InterconnectGroups that include this Interconnect.
      # Order is arbitrary and items are unique.
    &quot;A String&quot;,
  ],
  &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
      # 
      #    - PARTNER: A partner-managed interconnection shared between customers
      #    though a partner.
      #    - DEDICATED: A dedicated physical interconnection with the
      #    customer.
      # 
      # 
      # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
  &quot;kind&quot;: &quot;compute#interconnect&quot;, # [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
  &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
      # is essentially a hash of the labels set used for optimistic locking. The
      # fingerprint is initially generated by Compute Engine and changes after
      # every request to modify or update labels. You must always provide an
      # up-to-date fingerprint hash in order to update or change labels,
      # otherwise the request will fail with error412 conditionNotMet.
      # 
      # To see the latest fingerprint, make a get() request to
      # retrieve an Interconnect.
  &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      # Label values may be empty.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
      # 
      #    - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
      #    - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
      #    - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
      # 
      # 
      #  Note that this field indicates the speed of each of
      # the links in the bundle, not the speed of the entire bundle.
  &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
      # connection is to be provisioned.
  &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
      # Cloud Interconnect connection between Google and your on-premises router.
      # (MACsec) on this Cloud Interconnect connection between Google and your
      # on-premises router.
    &quot;failOpen&quot;: True or False, # If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google
        # router to fallback to cleartext traffic if the MKA session cannot be
        # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
        # MKA session cannot be established with your router.
    &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
        # along with their start times. A MACsec CKN/CAK is generated for each
        # key in the key chain. Google router automatically picks the key with
        # the most recent startTime when establishing or re-establishing a MACsec
        # secure link.
      { # Describes a pre-shared key used to setup MACsec in static connectivity
          # association key (CAK) mode.
        &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
            # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
            # characters long and match the regular expression
            # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
            # lowercase letter, and all following characters must be a dash,
            # lowercase letter, or digit, except the last character, which cannot be
            # a dash.
        &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
            # valid. startTime can be in the future. If the keychain has a single
            # key, startTime can be omitted. If the keychain has multiple keys,
            # startTime is mandatory for each key. The start times of keys must be in
            # increasing order. The start times of two consecutive keys must be
            # at least 6 hours apart.
      },
    ],
  },
  &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
      # fails if the MACsec object is not specified.
  &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
      # The name must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the name must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must be
      # a dash, lowercase letter, or digit, except the last character, which cannot
      # be a dash.
  &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
      # notifications regarding this Interconnect. If specified, this will be used
      # for notifications in addition to all other forms described, such as
      # Cloud Monitoring logs alerting and Cloud Notifications. This field is
      # required for users who sign up for Cloud Interconnect using
      # workforce identity federation.
  &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of this Interconnect&#x27;s functionality,
      # which can take one of the following values:
      # 
      #    - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
      #    use. Attachments may be provisioned on this Interconnect.
      # 
      # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
      # attachments may be provisioned on this Interconnect.
      # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
      # maintenance. No attachments may be provisioned or updated on this
      # Interconnect.
  &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
      # as part of resource payload.
    &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
        # Tag keys and values have the same definition as resource
        # manager tags. The field is allowed for INSERT
        # only. The keys/values to set on the resource should be specified in
        # either ID { : } or Namespaced format
        # { : }.
        # For example the following are valid inputs:
        # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
        # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
        # Note:
        # * Invalid combinations of ID &amp; namespaced format is not supported. For
        #   instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
        # * Inconsistent format is not supported. For instance:
        #   {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
  },
  &quot;peerIpAddress&quot;: &quot;A String&quot;, # [Output Only] IP address configured on the customer side of the
      # Interconnect link. The customer should configure this IP address during
      # turnup when prompted by Google NOC. This can be used only for ping tests.
  &quot;provisionedLinkCount&quot;: 42, # [Output Only] Number of links actually provisioned in this interconnect.
  &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
      # location outside of Google&#x27;s network that the interconnect is connected to.
  &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
      # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
      # Interconnect connection, which can take one of the following values:
      # 
      #    - IF_MACSEC: If specified, then the connection is created on MACsec
      #    capable hardware ports. If not specified, non-MACsec capable ports will
      #    also be considered.
      #    - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
      #    exclusively for Cross-Site Networking. The connection can not be used for
      #    Cross-Site Networking unless this feature is specified.
    &quot;A String&quot;,
  ],
  &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
      # customer.
  &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of Interconnect functionality, which can
      # take one of the following values:
      # 
      #    - ACTIVE: The Interconnect is valid, turned up and ready to use.
      #    Attachments may be provisioned on this Interconnect.
      #    - UNPROVISIONED: The Interconnect has not completed turnup. No
      #    attachments may be provisioned on this Interconnect.
      #    - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
      #    No attachments may be provisioned or updated on this
      #    Interconnect.
  &quot;subzone&quot;: &quot;A String&quot;, # Specific subzone in the InterconnectLocation that represents where
      # this connection is to be provisioned.
  &quot;wireGroups&quot;: [ # [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
      # configured to use this Interconnect. The Interconnect cannot be deleted if
      # this list is non-empty.
    &quot;A String&quot;,
  ],
}

  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.

For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.

The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
  <pre>Retrieves the list of Interconnects available to the specified project.

Args:
  project: string, Project ID for this request. (required)
  filter: string, A filter expression that filters resources listed in the response. Most
Compute resources support two types of filter expressions:
expressions that support regular expressions and expressions that follow
API improvement proposal AIP-160.
These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The operator
must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.

For example, if you are filtering Compute Engine instances, you can
exclude instances named `example-instance` by specifying
`name != example-instance`.

The `:*` comparison can be used to test whether a key has been defined.
For example, to find all objects with `owner` label use:
```
labels.owner:*
```

You can also filter nested fields. For example, you could specify
`scheduling.automaticRestart = false` to include instances only
if they are not scheduled for automatic restarts. You can use filtering
on nested fields to filter based onresource labels.

To filter on multiple expressions, provide each separate expression within
parentheses. For example:
```
(scheduling.automaticRestart = true)
(cpuPlatform = &quot;Intel Skylake&quot;)
```
By default, each expression is an `AND` expression. However, you
can include `AND` and `OR` expressions explicitly.
For example:
```
(cpuPlatform = &quot;Intel Skylake&quot;) OR
(cpuPlatform = &quot;Intel Broadwell&quot;) AND
(scheduling.automaticRestart = true)
```

If you want to use a regular expression, use the `eq` (equal) or `ne`
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:

`fieldname eq unquoted literal`
`fieldname eq &#x27;single quoted literal&#x27;`
`fieldname eq &quot;double quoted literal&quot;`
`(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`

The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.

For example, to filter for instances that do not end with name &quot;instance&quot;,
you would use `name ne .*instance`.

You cannot combine constraints on multiple fields using regular
expressions.
  maxResults: integer, The maximum number of results per page that should be returned.
If the number of available results is larger than `maxResults`,
Compute Engine returns a `nextPageToken` that can be used to get
the next page of results in subsequent list requests. Acceptable values are
`0` to `500`, inclusive. (Default: `500`)
  orderBy: string, Sorts list results by a certain order. By default, results
are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation
timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
results based on the `creationTimestamp` field in
reverse chronological order (newest result first). Use this to sort
resources like operations so that the newest operation is returned first.

Currently, only sorting by `name` or
`creationTimestamp desc` is supported.
  pageToken: string, Specifies a page token to use. Set `pageToken` to the
`nextPageToken` returned by a previous list request to get
the next page of results.
  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a
single zone scope either returns all resources in the zone or no resources,
with an error code.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to the list request, and contains a list of interconnects.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
  &quot;items&quot;: [ # A list of Interconnect resources.
    { # Represents an Interconnect resource.
        #
        # An Interconnect resource is a dedicated connection between the Google
        # Cloud network and your on-premises network. For more information, read the
        # Dedicated Interconnect Overview.
      &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
          # Interconnect.
      &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
          # Interconnect is functional and can carry traffic.
          # When set to false, no packets can be carried over the interconnect and
          # no BGP routes are exchanged over it. By default, the status is set to true.
      &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
          # Interconnect.
          # Interconnect.
        &quot;bandwidthPercentagePolicy&quot;: {
          &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
              # type Bandwidth Percent.
            { # Specify bandwidth percentages [1-100] for various traffic classes in
                # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
                # All traffic classes must have a percentage value specified.
              &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
              &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
            },
          ],
        },
        &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
            # Interconnect.
        &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
            # applied in conjunction with StrictPriorityPolicy or
            # BandwidthPercentagePolicy.
          { # Specify bandwidth percentages [1-100] for various traffic classes in
              # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
              # All traffic classes must have a percentage value specified.
            &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
            &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
          },
        ],
        &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
        },
      },
      &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
          # which can take one of the following values:
          #
          #    - IF_MACSEC: If present, then the Interconnect connection is
          #    provisioned on MACsec capable hardware ports. If not present, then the
          #    Interconnect connection is provisioned on non-MACsec capable ports. Any
          #    attempt to enable MACsec will fail.
          #    - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
          #    provisioned exclusively for Cross-Site Networking. Any attempt to configure
          #    VLAN attachments will fail. If not present, then the Interconnect
          #    connection is not provisioned for Cross-Site Networking. Any attempt to use
          #    it for Cross-Site Networking will fail.
        &quot;A String&quot;,
      ],
      &quot;circuitInfos&quot;: [ # [Output Only] A list of CircuitInfo objects, that describe the individual
          # circuits in this LAG.
        { # Describes a single physical circuit between the Customer and Google.
            # CircuitInfo objects are created by Google, so all fields are output only.
          &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
          &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
          &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
              # provided by Google to the customer in the LOA.
        },
      ],
      &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
          # text format.
      &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
          # authorized to request a crossconnect.
      &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
          # create the resource.
      &quot;expectedOutages&quot;: [ # [Output Only] A list of outages expected for this Interconnect.
        { # Description of a planned outage on this Interconnect.
          &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
              # IDs that will be affected.
            &quot;A String&quot;,
          ],
          &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
          &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
              # epoch).
          &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
              # values:
              #
              #    - OUTAGE: The Interconnect may be completely out of service for
              #    some or all of the specified window.
              #    - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
              #    should remain up, but with reduced bandwidth.
              #
              #
              # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
              # deprecated in favor of the unprefixed values.
          &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
          &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
              # value:
              #
              #    - GOOGLE: this notification as generated by Google.
              #
              #
              # Note that the value of NSRC_GOOGLE has been deprecated in favor of
              # GOOGLE.
          &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
              # epoch).
          &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
              #
              #    - ACTIVE: This outage notification is active. The event could be in
              #    the past, present, or future. See start_time and end_time for
              #    scheduling.
              #    - CANCELLED: The outage associated with this notification was cancelled
              #    before the outage was due to start.
              #    - COMPLETED: The outage associated with this notification is complete.
              #
              #
              # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
              # deprecated in favor of the unprefixed values.
        },
      ],
      &quot;googleIpAddress&quot;: &quot;A String&quot;, # [Output Only] IP address configured on the Google side of the Interconnect
          # link. This can be used only for ping tests.
      &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID to be used when raising support tickets
          # with Google or otherwise to debug backend connectivity issues.
      &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
          # defined by the server.
      &quot;interconnectAttachments&quot;: [ # [Output Only] A list of the URLs of all InterconnectAttachments configured
          # to use  this Interconnect.
        &quot;A String&quot;,
      ],
      &quot;interconnectGroups&quot;: [ # [Output Only] URLs of InterconnectGroups that include this Interconnect.
          # Order is arbitrary and items are unique.
        &quot;A String&quot;,
      ],
      &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
          #
          #    - PARTNER: A partner-managed interconnection shared between customers
          #    though a partner.
          #    - DEDICATED: A dedicated physical interconnection with the
          #    customer.
          #
          #
          # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
      &quot;kind&quot;: &quot;compute#interconnect&quot;, # [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
      &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
          # is essentially a hash of the labels set used for optimistic locking. The
          # fingerprint is initially generated by Compute Engine and changes after
          # every request to modify or update labels. You must always provide an
          # up-to-date fingerprint hash in order to update or change labels,
          # otherwise the request will fail with error412 conditionNotMet.
          #
          # To see the latest fingerprint, make a get() request to
          # retrieve an Interconnect.
      &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
          # Label values may be empty.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
          #
          #    - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
          #    - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
          #    - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
          #
          #
          #  Note that this field indicates the speed of each of
          # the links in the bundle, not the speed of the entire bundle.
      &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
          # connection is to be provisioned.
      &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
          # Cloud Interconnect connection between Google and your on-premises router.
          # (MACsec) on this Cloud Interconnect connection between Google and your
          # on-premises router.
        &quot;failOpen&quot;: True or False, # If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google
            # router to fallback to cleartext traffic if the MKA session cannot be
            # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
            # MKA session cannot be established with your router.
        &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
            # along with their start times. A MACsec CKN/CAK is generated for each
            # key in the key chain. Google router automatically picks the key with
            # the most recent startTime when establishing or re-establishing a MACsec
            # secure link.
          { # Describes a pre-shared key used to setup MACsec in static connectivity
              # association key (CAK) mode.
            &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
                # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
                # characters long and match the regular expression
                # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
                # lowercase letter, and all following characters must be a dash,
                # lowercase letter, or digit, except the last character, which cannot be
                # a dash.
            &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
                # valid. startTime can be in the future. If the keychain has a single
                # key, startTime can be omitted. If the keychain has multiple keys,
                # startTime is mandatory for each key. The start times of keys must be in
                # increasing order. The start times of two consecutive keys must be
                # at least 6 hours apart.
          },
        ],
      },
      &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
          # fails if the MACsec object is not specified.
      &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
          # The name must be 1-63 characters long, and comply withRFC1035.
          # Specifically, the name must be 1-63 characters long and match the regular
          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
          # character must be a lowercase letter, and all following characters must be
          # a dash, lowercase letter, or digit, except the last character, which cannot
          # be a dash.
      &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
          # notifications regarding this Interconnect. If specified, this will be used
          # for notifications in addition to all other forms described, such as
          # Cloud Monitoring logs alerting and Cloud Notifications. This field is
          # required for users who sign up for Cloud Interconnect using
          # workforce identity federation.
      &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of this Interconnect&#x27;s functionality,
          # which can take one of the following values:
          #
          #    - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
          #    use. Attachments may be provisioned on this Interconnect.
          #
          # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
          # attachments may be provisioned on this Interconnect.
          # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
          # maintenance. No attachments may be provisioned or updated on this
          # Interconnect.
      &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
          # as part of resource payload.
        &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
            # Tag keys and values have the same definition as resource
            # manager tags. The field is allowed for INSERT
            # only. The keys/values to set on the resource should be specified in
            # either ID { : } or Namespaced format
            # { : }.
            # For example the following are valid inputs:
            # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
            # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
            # Note:
            # * Invalid combinations of ID &amp; namespaced format is not supported. For
            #   instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
            # * Inconsistent format is not supported. For instance:
            #   {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
      },
      &quot;peerIpAddress&quot;: &quot;A String&quot;, # [Output Only] IP address configured on the customer side of the
          # Interconnect link. The customer should configure this IP address during
          # turnup when prompted by Google NOC. This can be used only for ping tests.
      &quot;provisionedLinkCount&quot;: 42, # [Output Only] Number of links actually provisioned in this interconnect.
      &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
          # location outside of Google&#x27;s network that the interconnect is connected to.
      &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
          # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
          # Interconnect connection, which can take one of the following values:
          #
          #    - IF_MACSEC: If specified, then the connection is created on MACsec
          #    capable hardware ports. If not specified, non-MACsec capable ports will
          #    also be considered.
          #    - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
          #    exclusively for Cross-Site Networking. The connection can not be used for
          #    Cross-Site Networking unless this feature is specified.
        &quot;A String&quot;,
      ],
      &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
          # customer.
      &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
      &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
      &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of Interconnect functionality, which can
          # take one of the following values:
          #
          #    - ACTIVE: The Interconnect is valid, turned up and ready to use.
          #    Attachments may be provisioned on this Interconnect.
          #    - UNPROVISIONED: The Interconnect has not completed turnup. No
          #    attachments may be provisioned on this Interconnect.
          #    - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
          #    No attachments may be provisioned or updated on this
          #    Interconnect.
      &quot;subzone&quot;: &quot;A String&quot;, # Specific subzone in the InterconnectLocation that represents where
          # this connection is to be provisioned.
      &quot;wireGroups&quot;: [ # [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
          # configured to use this Interconnect. The Interconnect cannot be deleted if
          # this list is non-empty.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;kind&quot;: &quot;compute#interconnectList&quot;, # [Output Only] Type of resource. Alwayscompute#interconnectList for lists of interconnects.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
      # the query parameter pageToken in the next list request.
      # Subsequent list requests will have their own nextPageToken to
      # continue paging through the results.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
  &quot;warning&quot;: { # [Output Only] Informational warning message.
    &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
        # Engine returns NO_RESULTS_ON_PAGE if there
        # are no results in the response.
    &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
        # value format. For example:
        #
        # &quot;data&quot;: [
        #   {
        #    &quot;key&quot;: &quot;scope&quot;,
        #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
        #   }
      {
        &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
            # returned. For example, for warnings where there are no results in a list
            # request for a particular zone, this key might be scope and
            # the key value might be the zone name. Other examples might be a key
            # indicating a deprecated resource and a suggested replacement, or a
            # warning about invalid network settings (for example, if an instance
            # attempts to perform IP forwarding but is not enabled for IP forwarding).
        &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(project, interconnect, body=None, requestId=None, x__xgafv=None)</code>
  <pre>Updates the specified Interconnect with the data included in the request.
This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.

Args:
  project: string, Project ID for this request. (required)
  interconnect: string, Name of the interconnect to update. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an Interconnect resource.
    # 
    # An Interconnect resource is a dedicated connection between the Google
    # Cloud network and your on-premises network. For more information, read the
    # Dedicated Interconnect Overview.
  &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
      # Interconnect.
  &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
      # Interconnect is functional and can carry traffic.
      # When set to false, no packets can be carried over the interconnect and
      # no BGP routes are exchanged over it. By default, the status is set to true.
  &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
      # Interconnect.
      # Interconnect.
    &quot;bandwidthPercentagePolicy&quot;: {
      &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
          # type Bandwidth Percent.
        { # Specify bandwidth percentages [1-100] for various traffic classes in
            # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
            # All traffic classes must have a percentage value specified.
          &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
          &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
        },
      ],
    },
    &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
        # Interconnect.
    &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
        # applied in conjunction with StrictPriorityPolicy or
        # BandwidthPercentagePolicy.
      { # Specify bandwidth percentages [1-100] for various traffic classes in
          # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
          # All traffic classes must have a percentage value specified.
        &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
        &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
      },
    ],
    &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
    },
  },
  &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
      # which can take one of the following values:
      # 
      #    - IF_MACSEC: If present, then the Interconnect connection is
      #    provisioned on MACsec capable hardware ports. If not present, then the
      #    Interconnect connection is provisioned on non-MACsec capable ports. Any
      #    attempt to enable MACsec will fail.
      #    - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
      #    provisioned exclusively for Cross-Site Networking. Any attempt to configure
      #    VLAN attachments will fail. If not present, then the Interconnect
      #    connection is not provisioned for Cross-Site Networking. Any attempt to use
      #    it for Cross-Site Networking will fail.
    &quot;A String&quot;,
  ],
  &quot;circuitInfos&quot;: [ # [Output Only] A list of CircuitInfo objects, that describe the individual
      # circuits in this LAG.
    { # Describes a single physical circuit between the Customer and Google.
        # CircuitInfo objects are created by Google, so all fields are output only.
      &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
      &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
      &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
          # provided by Google to the customer in the LOA.
    },
  ],
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
      # text format.
  &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
      # authorized to request a crossconnect.
  &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
      # create the resource.
  &quot;expectedOutages&quot;: [ # [Output Only] A list of outages expected for this Interconnect.
    { # Description of a planned outage on this Interconnect.
      &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
          # IDs that will be affected.
        &quot;A String&quot;,
      ],
      &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
      &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
          # epoch).
      &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
          # values:
          #
          #    - OUTAGE: The Interconnect may be completely out of service for
          #    some or all of the specified window.
          #    - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
          #    should remain up, but with reduced bandwidth.
          #
          #
          # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
          # deprecated in favor of the unprefixed values.
      &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
      &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
          # value:
          #
          #    - GOOGLE: this notification as generated by Google.
          #
          #
          # Note that the value of NSRC_GOOGLE has been deprecated in favor of
          # GOOGLE.
      &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
          # epoch).
      &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
          #
          #    - ACTIVE: This outage notification is active. The event could be in
          #    the past, present, or future. See start_time and end_time for
          #    scheduling.
          #    - CANCELLED: The outage associated with this notification was cancelled
          #    before the outage was due to start.
          #    - COMPLETED: The outage associated with this notification is complete.
          #
          #
          # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
          # deprecated in favor of the unprefixed values.
    },
  ],
  &quot;googleIpAddress&quot;: &quot;A String&quot;, # [Output Only] IP address configured on the Google side of the Interconnect
      # link. This can be used only for ping tests.
  &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID to be used when raising support tickets
      # with Google or otherwise to debug backend connectivity issues.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
      # defined by the server.
  &quot;interconnectAttachments&quot;: [ # [Output Only] A list of the URLs of all InterconnectAttachments configured
      # to use  this Interconnect.
    &quot;A String&quot;,
  ],
  &quot;interconnectGroups&quot;: [ # [Output Only] URLs of InterconnectGroups that include this Interconnect.
      # Order is arbitrary and items are unique.
    &quot;A String&quot;,
  ],
  &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
      # 
      #    - PARTNER: A partner-managed interconnection shared between customers
      #    though a partner.
      #    - DEDICATED: A dedicated physical interconnection with the
      #    customer.
      # 
      # 
      # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
  &quot;kind&quot;: &quot;compute#interconnect&quot;, # [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
  &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
      # is essentially a hash of the labels set used for optimistic locking. The
      # fingerprint is initially generated by Compute Engine and changes after
      # every request to modify or update labels. You must always provide an
      # up-to-date fingerprint hash in order to update or change labels,
      # otherwise the request will fail with error412 conditionNotMet.
      # 
      # To see the latest fingerprint, make a get() request to
      # retrieve an Interconnect.
  &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      # Label values may be empty.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
      # 
      #    - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
      #    - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
      #    - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
      # 
      # 
      #  Note that this field indicates the speed of each of
      # the links in the bundle, not the speed of the entire bundle.
  &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
      # connection is to be provisioned.
  &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
      # Cloud Interconnect connection between Google and your on-premises router.
      # (MACsec) on this Cloud Interconnect connection between Google and your
      # on-premises router.
    &quot;failOpen&quot;: True or False, # If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google
        # router to fallback to cleartext traffic if the MKA session cannot be
        # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
        # MKA session cannot be established with your router.
    &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
        # along with their start times. A MACsec CKN/CAK is generated for each
        # key in the key chain. Google router automatically picks the key with
        # the most recent startTime when establishing or re-establishing a MACsec
        # secure link.
      { # Describes a pre-shared key used to setup MACsec in static connectivity
          # association key (CAK) mode.
        &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
            # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
            # characters long and match the regular expression
            # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
            # lowercase letter, and all following characters must be a dash,
            # lowercase letter, or digit, except the last character, which cannot be
            # a dash.
        &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
            # valid. startTime can be in the future. If the keychain has a single
            # key, startTime can be omitted. If the keychain has multiple keys,
            # startTime is mandatory for each key. The start times of keys must be in
            # increasing order. The start times of two consecutive keys must be
            # at least 6 hours apart.
      },
    ],
  },
  &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
      # fails if the MACsec object is not specified.
  &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
      # The name must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the name must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must be
      # a dash, lowercase letter, or digit, except the last character, which cannot
      # be a dash.
  &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
      # notifications regarding this Interconnect. If specified, this will be used
      # for notifications in addition to all other forms described, such as
      # Cloud Monitoring logs alerting and Cloud Notifications. This field is
      # required for users who sign up for Cloud Interconnect using
      # workforce identity federation.
  &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of this Interconnect&#x27;s functionality,
      # which can take one of the following values:
      # 
      #    - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
      #    use. Attachments may be provisioned on this Interconnect.
      # 
      # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
      # attachments may be provisioned on this Interconnect.
      # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
      # maintenance. No attachments may be provisioned or updated on this
      # Interconnect.
  &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
      # as part of resource payload.
    &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
        # Tag keys and values have the same definition as resource
        # manager tags. The field is allowed for INSERT
        # only. The keys/values to set on the resource should be specified in
        # either ID { : } or Namespaced format
        # { : }.
        # For example the following are valid inputs:
        # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
        # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
        # Note:
        # * Invalid combinations of ID &amp; namespaced format is not supported. For
        #   instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
        # * Inconsistent format is not supported. For instance:
        #   {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
  },
  &quot;peerIpAddress&quot;: &quot;A String&quot;, # [Output Only] IP address configured on the customer side of the
      # Interconnect link. The customer should configure this IP address during
      # turnup when prompted by Google NOC. This can be used only for ping tests.
  &quot;provisionedLinkCount&quot;: 42, # [Output Only] Number of links actually provisioned in this interconnect.
  &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
      # location outside of Google&#x27;s network that the interconnect is connected to.
  &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
      # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
      # Interconnect connection, which can take one of the following values:
      # 
      #    - IF_MACSEC: If specified, then the connection is created on MACsec
      #    capable hardware ports. If not specified, non-MACsec capable ports will
      #    also be considered.
      #    - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
      #    exclusively for Cross-Site Networking. The connection can not be used for
      #    Cross-Site Networking unless this feature is specified.
    &quot;A String&quot;,
  ],
  &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
      # customer.
  &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of Interconnect functionality, which can
      # take one of the following values:
      # 
      #    - ACTIVE: The Interconnect is valid, turned up and ready to use.
      #    Attachments may be provisioned on this Interconnect.
      #    - UNPROVISIONED: The Interconnect has not completed turnup. No
      #    attachments may be provisioned on this Interconnect.
      #    - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
      #    No attachments may be provisioned or updated on this
      #    Interconnect.
  &quot;subzone&quot;: &quot;A String&quot;, # Specific subzone in the InterconnectLocation that represents where
      # this connection is to be provisioned.
  &quot;wireGroups&quot;: [ # [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
      # configured to use this Interconnect. The Interconnect cannot be deleted if
      # this list is non-empty.
    &quot;A String&quot;,
  ],
}

  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.

For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.

The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

<div class="method">
    <code class="details" id="setLabels">setLabels(project, resource, body=None, x__xgafv=None)</code>
  <pre>Sets the labels on an Interconnect. To learn more about labels,
read the Labeling
Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  resource: string, Name or id of the resource for this request. (required)
  body: object, The request body.
    The object takes the form of:

{
  &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
      # used to detect conflicts. The fingerprint is initially generated by Compute
      # Engine and changes after every request to modify or update labels. You must
      # always provide an up-to-date fingerprint hash when updating or changing
      # labels, otherwise the request will fail with error412 conditionNotMet.  Make a get() request to the
      # resource to get the latest fingerprint.
  &quot;labels&quot;: { # A list of labels to apply for this resource. Each label must comply with
      # the
      # requirements for labels. For example,&quot;webserver-frontend&quot;: &quot;images&quot;. A label value can also be
      # empty (e.g. &quot;my-label&quot;: &quot;&quot;).
    &quot;a_key&quot;: &quot;A String&quot;,
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

</body></html>